home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / NEWSOFT / MARCH / MAPPER / !Mapper_o / !Help < prev    next >
Text File  |  1997-11-01  |  13KB  |  376 lines

  1.                      *   *   *** ****  ****  ***** ****
  2.                      ** **  *  * *   * *   * *     *   *
  3.                      * * * ***** ****  ****  ***   ****
  4.                      *   * *   * *     *     *     *   *
  5.                      *   * *   * *     *     ***** *    *
  6.  
  7.                      Version : 4.00 Released : 14/12/96
  8.                      Version : 4.10 Updated  : 1/11/97
  9.  
  10. I.  Contents :
  11.  
  12.     1............Introduction
  13.     2............What is a map editor ?
  14.     3............The legal bit
  15.     3............The differences
  16.     3............System requirements
  17.     3............Extra commands
  18.     4............The WIMP options
  19.     5............The editing screen
  20.     5............Key commands
  21.     6............The Sprite Overlay System™
  22.     6............Saving and loading
  23.     7............MAP format
  24.     A............Glossary
  25.     B............And finally...
  26.     C............The new bits...
  27.  
  28. 1.  Introduction 
  29. ----------------
  30.  
  31. Welcome to the very last version of !Mapper - because this is the ultimate
  32. version of my !Mapper series, there is no need to do any more, apart from
  33. probably the odd bug fix or update.
  34.  
  35. 2.  What is a map editor?
  36. -------------------------
  37.  
  38. A map editor is normally used for 2D games, for example Chaos Engine, Cannon
  39. Fodder etc. etc., and allows you to position background sprites anywhere
  40. within a defined area.  When you come to display the background in your
  41. program, the code used will tell you which sprite you need to display.  
  42.  
  43. You could do things the hard way, and design the background completely in
  44. some art package, but to do so will use a lot of memory and you will have a
  45. hard job animating sprites and performing special actions.
  46.  
  47. Alternatively you could type in DATA statements into your program, but doing
  48. so is slow, boring and prone to error.
  49.  
  50. Let !Mapper V4.xx increase your productivity...
  51.  
  52. 3.  The legal bit
  53. -----------------
  54.  
  55. !Mapper+, !Mapper V3.xx, and !Mapper V4.xx are 
  56. (C) Nicholas Kingsley Bsc 1995/1996
  57.  
  58. The Sprite Overlay System is trademark of Nicholas Kingsley
  59.  
  60. All unauthorised coping, reverse engineering, lending, loaning is strictly
  61. forbidden without MY WRITTEN PERMISSION.
  62.  
  63. Thanks to Pineapple Software for the filetype allocation of the MAP
  64. filetype.
  65.  
  66. 4.  The differences
  67. -------------------                     
  68.  
  69. Most of the options in !Mapper V3.xx were not needed.  Here is a list of the
  70. differences between the two :
  71.  
  72. Functions removed :
  73.  
  74. A)  X and Y Mirroring
  75. B)  Compression saving
  76. C)  Virtual memory
  77. D)  Editing grid
  78.  
  79. Functions that are the same :
  80.  
  81. A)  Mouse functions are generally the same
  82. B)  The WIMP options are the same (but have been extended)
  83.  
  84. Functions added :
  85.  
  86. A)  Multiple editing modes 
  87. B)  Sprite Overlay System™ 
  88. C)  Each sprite has status information
  89.  
  90. 5.  System Requirements 
  91. ----------------------
  92.  
  93. You will need at least 1Mb to run this program (although you can change
  94. various items to run the program if you are low in memory).  The program has
  95. only be tested on a RISC OS V3.11 and so MAY NOT run on other machines. 
  96.  
  97. UPDATE : This program will run on a StrongArm computer.
  98.  
  99. 5.  Extra commands
  100. ------------------
  101.  
  102. The following commands must be placed just before the comment on the last
  103. line of the !Run file.  Each command must be separated from the previous
  104. command and the parameter value by a space.
  105.  
  106. The commands are :
  107.  
  108. -xsize <value> - This changes the default value for the maximum value for
  109. the map width.  The value can be any size between 1 and 255
  110.  
  111. -ysize <value> - This changes the default value for the maximum value for
  112. the map height.  The value can be any size between 1 and 255
  113.  
  114. -layers <value> - This changes the default value for the number of layers. 
  115. The value can be between 1 and 255
  116.  
  117. -sprites <values> - This changes the default value for the maximum number of
  118. sprites that can be read.  The value can be between 1 and 999
  119.  
  120. UPDATE :
  121.  
  122. -repeat <value> - This changes the speed at which the computer scrolls through
  123. the different sprites.  The value can be between 1 and 255
  124.  
  125. NOTE : If the computer can't claim enough memory for any value, an error
  126. message will be displayed, and the program will remove itself from memory.
  127.  
  128. 6.  The WIMP options 
  129. --------------------
  130.  
  131. There are very few WIMP options.  These are to be found in "Change Map" and
  132. "Save Map".  The values in "Change Map" affect ALL the layers.
  133.  
  134. The "Change Map" options are :
  135.  
  136. Layer X Size - This allows any value between 1 and the current maximum 
  137.                width allowed, and changes the width of the map.
  138. Layer Y Size - This allows any value between 1 and the current maximum
  139.                height allowed, and changes the height of the map.
  140. Delete value - This allows any value between 0 and 65535, and governs what
  141.                value is stored when the delete button is pressed on the
  142.                mouse.  Delete values can have sprites associated with them,
  143.                and if they do then the correct sprite is displayed when you
  144.                delete graphic.
  145. Mask value   - This allows any value between 0 and 255 and is only used with
  146.                the Sprite Overlay System™.  This governs what value will be
  147.                ignored multiple layers are displayed.  Please read the
  148.                overlay system text
  149.  
  150. The following headings allow you to set up global status values, without
  151. having to press the MIDDLE button after plotting each tile :
  152.  
  153. Walkability, Special #1, Special #2 and Special #3 - Click on the box to
  154. active the speciality.
  155.  
  156. Animation frames - Used only in your own programs, this lets you know how
  157. many animation frames a tile has
  158.  
  159. X Modify and Y Modify - Activated ONLY when Special #3 has been selected,
  160. this is only used in your own programs to help implement hidden walls,
  161. floors etc., by defining the character X and Y position
  162.  
  163. L Modify - Used as above, but specifies which layer the hidden tile is on.
  164.  
  165. The "Save Map" options :
  166.  
  167. The button next to "All" determines how many layers are saved.  With it
  168. crossed then ALL layers are saved.  When it isn't then only the CURRENT
  169. EDITED layer is saved.
  170.  
  171. 7.  The editing screen
  172. ----------------------
  173.  
  174. In the default editing map ("Normal editing") then screen is split into
  175. two parts.  The top displays the sprites, while the second part at the
  176. bottom displays some useful information about the current layer :
  177.  
  178. Layr  - Current layer number 
  179. XSize - Current WIDTH of the map
  180. YSize - Current HEIGHT of the map
  181. X:    - Current X position of the pointer in the current layer  
  182. Y:    - Current Y position of the pointer in the current layer
  183.  
  184. The boxes in the left size of the screen contain the previous sprite
  185. graphic, the current sprite graphic and the next sprite graphic.  Clicking
  186. on the left hand arrow with the LEFT mouse button moves the sprites right
  187. (allows you to select the previous sprite), while clicking on the RIGHT
  188. button moves the sprites left (allows you to select the next sprite).
  189.  
  190. The sprite in the middle is the currently selected sprite (CSS).
  191.  
  192. Clicking on the left hand arrow with the RIGHT button positions the sprites
  193. so that the FIRST sprite is the CSS, while clicking on the right hand arrow
  194. with the RIGHT button positions the sprites so that the LAST sprite is the
  195. CSS.
  196.  
  197. The arrows underneath the word "Layr" selects which layer will be currently
  198. edited.  Clicking on the left hand arrow with the LEFT mouse button selects
  199. the previous layer, while clicking on the right hand arrow with the LEFT
  200. button selects the next layer.
  201.  
  202. Clicking on the left hand arrow with the RIGHT mouse button selects the
  203. FIRST layer, while clicking on the right hand arrow with the RIGHT button
  204. selects the LAST layer. 
  205.  
  206. The characters underneath the word "Status" show the status of the sprite
  207. currently under the pointer.  If a character is "lit up" (not grey), then
  208. that speciality is active.  
  209.  
  210. The specialities are :
  211.  
  212. W - Walkability  (Can the player move ONTO this tile ?) 
  213. 1 - Special #1   (Is this tile in Special group #1) 
  214. 2 - Special #2   (Is this tile in Special group #2) 
  215. 3 - Special #3.  This is different to the previous specialities in as much
  216.                  as when this is active a number will be displayed on the
  217.                  line below.  These are the grid references (X and Y) of a
  218.                  tile that will be modified when the player steps onto the
  219.                  CSS.  Beneath these values holds the layer of the tile that
  220.                  will be modified.
  221.  
  222. You can only modify the specialities when in "normal editing mode".  
  223.  
  224. Version V4.00 ONLY : To do so, press the MIDDLE mouse button and go through
  225. all the questions at the bottom of the screen, and where appropriate entering
  226. values.  The LEFT mouse button confirms a question, while the other two don't.
  227.  
  228. The value to the right of the "Anim:" word contains the number of frames of
  229. animation for that tile.
  230.  
  231. 8.  Key commands
  232. ----------------
  233.  
  234. The following keys can be used in any mode  :
  235.  
  236. The Space bar - wraps around between normal editing, full screen editing
  237.                 and the Sprite Overlay System™
  238. ⇦ ⇧ ⇨ ⇩       - Scrolls the editing or Overlay screen around
  239. Home          - Re-displays the current layer from the top left
  240.  
  241. 9.  The Sprite Overlay System™
  242. ------------------------------
  243.  
  244. This is a very powerful feature allowing you to position your sprites
  245. EXACTLY where you want them.
  246.  
  247. Each layer is displayed from the first (or BASE layer) to the very last, in
  248. such a way that, created properly, all sprites at a certain position can be
  249. displayed.
  250.  
  251. 10. Saving and loading
  252. ----------------------
  253.  
  254. Before editing can commence, a sprite file needs to be dragged to the
  255. !Mapper icon.  If no valid sprites are found then an error message is
  256. displayed.
  257.  
  258. MAP files can also be dragged to the !Mapper icon and will use the currently
  259. stored sprites.  In addition, MAP files can also be loaded by
  260. double-clicking on the MAP icon.
  261.  
  262. MAP files from !Mapper V3.xx is NOT compatible.
  263.  
  264. To save a MAP file just drag the MAP icon to a directory, press the OK
  265. button or type in a filename.  The selectable icon to the right of the icon
  266. graphic determines whether all layers are saved (star is in the box) or the
  267. current layer only is saved (box is clear).
  268.  
  269. NOTE : Layers that are saved singly can ONLY be loaded into the layer that
  270. they were saved from.
  271.  
  272. 11. MAP format
  273. --------------
  274.  
  275. The format of the MAP file is as follows :
  276.  
  277. +0  (4 Bytes) - Header (&19861987)
  278. +4  (2 Bytes) - Map width
  279. +6  (2 Bytes) - Map height
  280. +8  (1 Byte)  - Type of saving 0 - All layers saved
  281.                               >0 - Given layer is saved
  282.  
  283. This is followed by the tile data :
  284.  
  285. +0  (2 Bytes) - Sprite number
  286. +2  (1 Byte)  - Sprite status - Bit 0 Set - Walkability
  287.                                 Bit 1 Set - Special #1
  288.                                 Bit 2 Set - Special #2
  289.                                 Bit 3 Set - Special #3
  290. +3  (1 Byte)  - No. of frames of animation
  291. +4  (1 Byte)  - X Modify location    
  292. +5  (1 Byte)  - Y Modify location    
  293. +6  (1 Byte)  - Modify layer value  
  294.  
  295. A.  Glossary 
  296. ------------
  297.  
  298. BASE LAYER - The first layer which is used to hold floor, walls, grass,
  299. doors, water and mud etc. sprites.
  300.  
  301. TILE - A Sprite.
  302.  
  303. SPRITE STATUS - Holds each tiles speciality.
  304.  
  305. SPECIALITY - Defines how the player should react to a given tile.  The
  306. specialities are : Walkability (can the player walk ONTO this tile ?),
  307. Special #1, Special #2 (These are for the user's use) and Special #3 (Which
  308. allows the programmer to modify a tile)
  309.  
  310. SPRITE OVERLAY SYSTEM™ - Overlays layers so that A) You can position sprites
  311. correctly and B) You can see which sprites go where.
  312.  
  313. LAYER - A group of tiles
  314.  
  315. MODIFICATION LOCATION - Allows easy programming of 'hidden' walls etc., by
  316. storing the X, Y and layer number of the sprite the program has to modify.
  317.  
  318. MAP - A group of layers  
  319.  
  320. B.  And finally...
  321. ------------------
  322.  
  323. Whilst they shouldn't be any problems with the program, you can contact me
  324. by sending E-Mail to : nichk@argonet.co.uk
  325.  
  326. C.  The new bits...
  327. -------------------
  328.  
  329. Since this program was written, the StrongArm computer has come out.  Being much
  330. faster than the programmers original computer, it was found that a slight
  331. modification was needed to allow the user to successfully choose different
  332. sprites and layers.  In addition, a new 'speciality' has been added : The
  333. 'OPAQUE' speciality.  This allows the programmer to code hidden doors, walls
  334. etc easily without having to use any of the original specialities.
  335.  
  336. The specialities can now be entered in a much easier way using a 'LOCK'. 
  337. Pressing the MIDDLE button within the editing area with put a red rectangle
  338. around the current sprite.  This sprite is then locked.  This means that,
  339. until the MIDDLE button is pressed again, the only thing you can modify on
  340. that tile is the specialities.  
  341.  
  342. To do that, press the LEFT mouse button over the 'W123O' letters to toggle
  343. them on and off.  If speciality #3 is active, then, you can modify the
  344. modification X, Y and layer values by pressing the LEFT mouse button between
  345. the brackets.
  346.  
  347. To modify the animation value, just LEFT click on the three numbers.
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.